Table of Contents
Interoperable Vendors
Copyright
© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved. The compilation (meaning the collection, arrangement and assembly) of all content on this site is protected by U.S. and international copyright laws and treaty provisions and may not be used, copied, reproduced, modified, published, uploaded, posted, transmitted or distributed in any way, without prior written consent of Ribbon Communications Inc.
The trademarks, logos, service marks, trade names, and trade dress (“look and feel”) on this website, including without limitation the RIBBON and RIBBON logo marks, are protected by applicable US and foreign trademark rights and other proprietary rights and are the property of Ribbon Communications Operating Company, Inc. or its affiliates. Any third-party trademarks, logos, service marks, trade names and trade dress may be the property of their respective owners. Any uses of the trademarks, logos, service marks, trade names, and trade dress without the prior written consent of Ribbon Communications Operating Company, Inc., its affiliates, or the third parties that own the proprietary rights, are expressly prohibited.
Document Overview
This document provides a configuration guide for Ribbon SBC SWe Core when connecting to Cisco Broadworks Network Server/ Application Server for Interop testing.
A Session Border Controller (SBC) is a network element deployed to protect SIP-based Voice over Internet Protocol (VoIP) networks. Early deployments of SBCs were focused on the borders between two service provider networks in a peering environment. This role has now expanded to include significant deployments between a service provider's access network and a backbone network to provide service to residential and/or enterprise customers.
This guide contains the following configuration sections:
- Section A: SBC Core Configuration
- Captures general SBC Core configurations for deploying with Broadsoft server.
Section B: Configuration of Cisco Broadsoft
Captures the Broadsoft configuration.
Test all basic calls, along with the supplementary features like call hold, call transfer, and conference with configurations from Section A and Section B.
Configure Advanced supplementary features on Broadsoft as mentioned in Supplementary Services Configuration on Broadsoft.
These include:
Surrogate Registration
Voice Portal
Network Conference
Shared Call Appearance
- Call Origination/ Termination
- Call Forward
- Session Audit
- Calling Line ID
- Call Waiting
- Session Timer
- G.711 FAX passthrough
- Advanced Call Control
- DTMF
- Call Transfer
- Busy Lamp Field
Note
SBC 5x10, 5400, 7000 and SWe are represented as SBC Core in the following sections.
Non-Goals
It is not the goal of this guide to provide detailed configurations that will meet the requirements of every customer. Use this guide as a starting point and build the SBC configurations in consultation with network design and deployment engineers.
Audience
This is a technical document intended for telecommunications engineers with the purpose of configuring the Ribbon SBC.
To perform this interop, you need
- to use graphical user interface (GUI) or command line interface (CLI) of the Ribbon product.
- to understand the basic concepts of TCP/UDP/TLS and IP/Routing.
- to have SIP/RTP/SRTP to complete the configuration and for troubleshooting.
Note
This configuration guide is offered as a convenience to Ribbon customers. The specifications and information regarding the product in this guide are subject to change without notice. All statements, information, and recommendations in this guide are believed to be accurate but are presented without warranty of any kind, express or implied, and are provided “AS IS”. Users must take full responsibility for the application of the specifications and information in this guide.
Prerequisites
The following aspects are required before proceeding with the interop:
- Ribbon SWe Core
- SWe Core License
- This interop requires the acquisition and application of SIP sessions, as documented at Managing SBC Licenses
- SBC must be configured with appropriate licenses.
- Broadsoft servers
- Broadsoft needs to configured with appropriate licenses ,refer to https://www.cisco.com for more information about licenses
- UC One clients
- Polycom Phones
Product and Device Details
The following equipment and software were used for the sample configuration provided:
Requirements
Equipment | Software/Firmware Version | |
|---|---|---|
| Ribbon Communications | Ribbon SWe Core | V08.02.03R0 |
| Broadsoft server | Broadsoft server version | R24 |
Third-party Equipment | Kapanga Softphone | 1.00 |
| Polycom | 4.1.1.0731 | |
| UCOne client | 5.3.8 |
Note
The Ribbon SBC Core portfolio includes SBC 5x10, SBC 5400, SBC 7000 (appliance based), and SBC SWe (cloud/virtualized platform). The software version is applicable to Ribbon SBC Core portfolio, and hence, this configuration guide is valid for all these devices.
Network Topology Diagram
This section covers the SBC Core deployment topology and the Interoperability Test Lab Topology.
SBC Core Deployment Topology
SBC Core Deployment Topology
Interoperability Test Lab Topology
The following lab topology diagram shows connectivity between Broadsoft servers and Ribbon SBC Core.
Interoperabilty Test Lab topology
Installation Procedure
- Installation of SBC Core
- To deploy an SBC Core instance, refer to https://doc.rbbn.com/display/SBXDOC101/Installing+SBC+Core+Software
- Installation of Broadworks Application Server
- Broadsoft needs to configured with appropriate licenses and R24 build. Also ensure that 5 users with groups should be created ie A1,A2,B1,C1,D1
Broadsoft Users:
- User A1 – SIP phone or access device, which registers with Broadworks having SBC as outbound proxy.
- User A2 – SIP phone or access device, which registers with Broadworks having SBC as outbound proxy.
- User B1 – SIP phone or access device, which registers directly with BroadWorks.
- User C1 – SIP phone or access device, which registers directly with BroadWorks.
- User D1 – IP-PBX user; IP-PBX registers trunk with Broadworks having SBC as outbound proxy.
Document Workflow
Section A: SBC Core Configuration
The following SBC Core configurations are included in this section:
- Global Configuration
- ACCESS Leg Configuration
- Static Routes Configuration
- Global Call Routing Configuration
SBC Core specific configuration related to ACCESS is covered under ACCESS Leg Configuration.
SBC Core specific configuration related to Broadsoft is covered under CORE Leg Configuration.
Global Configuration
Configure below entities as part of Global Configuration
- SIP Max PDU Size
- SIP Domain
- Crankback Profile
- UDP Port Range for RTP
- DSP Resource Allocation
- MultipleContactHeader
1.1 SIP Max PDU Size
Increase the maximum PDU size from 6 kb to 60 kb to accommodate larger SIP packets.
set system mediaProfile compression 90 tone 10 commit set system media mediaPortRange baseUdpPort 16384 maxUdpPort 32767 commit
1.2 SIP Domain
Specify the global SIP Domain name.
set global sipDomain STBROADSOFT.COM commit
1.3 Crankback Profile
Add call release (reason) code 102 (Recovery on Timer Expiry) to the default Crankback Profile. The Crankback Profile contains the call release codes that automatically cause the SBC to attempt to reroute the call.
set profiles callRouting crankbackProfile default reason 102 commit
1.4 UDP Port Range for RTP (optional)
The Ribbon SBC Core Portfolio defaults to using the UDP port range of 1024 - 65148 for RTP (media) traffic. Many enterprise networking devices, including security devices may assume a range of 16384 - 32767.
If required, the following configuration modifies the SBC to work within the limited range with no change to the existing devices. This is a global change.
set system media mediaPortRange baseUdpPort 16384 maxUdpPort 32767 commit
1.5 DSP Resource Allocation
This configuration only applies if the SBC is deployed with (hardware) DSP resources. If it has not, executing these configuration steps has no negative impact.
Subsequent configuration sections (Packet service profiles) do not attempt transcoding, so lack of compression resources will not impact the overall SBC configuration in this document.
set system mediaProfile compression 90 tone 10 commit
1.6 MultipleContactHeader per AoR
To disable multiple contacts per AOR, the “multipleContactsPerAor” system-level flag must be disabled as shown in the example below (default configuration is ‘enabled’).
In BSFT deployment, when customers do not want to allow multiple devices to use the same AoR, disable this flag. Since BSFT handles the multiple devices per AoR using different AoR suffixes, there is no need to have multiple Contact Headers per AoR.
set global signaling sipSigControls multipleContactsPerAor disabled commit
ACCESS Leg Configuration
Create entities with a specific set of characteristics corresponding to ACCESS. This includes configuration of the following on ACCESS leg:
- Codec Entry
- Packet Service Profile
- IP Signaling Profile
- SipAdaptor Profile
- SipParamFilterProfile
- Prefix Profile
- Numbering Plan
- Digit Manipulation
- Element Routing Priority
- Transparency Profile
- IP Interface Group
- Surrogate registration Profile
- Zone
- SIP Signaling Port
- IP Peer
- IP Signaling Peer Group
- SIP Trunk Group
2.1 Codec Entry
Codec entry allows you to specify the codec used for the call. Create the codec entry for G711Ulaw codec with packet size 20 and rfc2833 method for DTMF.
set profiles media codecEntry G711_ALAW_PTIME_20 codec g711 law ALaw packetSize 20 set profiles media codecEntry G729AB-DEFAULT codec g729ab packetSize 20 set profiles media codecEntry G711_ALAW_PTIME_20 dtmf relay rfc2833 commit
2.2 Packet Service Profile (PSP)
Create a Packet Service Profile (PSP) for the PSTN leg. The PSP is attached to sipTrunkGroup created later in this section.
set profiles media packetServiceProfile ACCESS_PSP packetToPacketControl transcode transcoderFreeTransparency set profiles media packetServiceProfile ACCESS_PSP videoCalls maxVideoBandwith 4096 set profiles media packetServiceProfile ACCESS_PSP rtcpOptions rtcp enable set profiles media packetServiceProfile ACCESS_PSP codec codecEntry1 G729AB-DEFAULT set profiles media packetServiceProfile ACCESS_PSP codec codecEntry2 G711_ALAW_PTIME_20 commit set profiles media packetServiceProfile GIN_ACCESS_PSP packetToPacketControl transcode transcoderFreeTransparency commit set profiles media packetServiceProfile PBX123_PSP packetToPacketControl transcode transcoderFreeTransparency commit
2.3 IP Signaling Profile (IPSP)
Create an IP Signaling Profile with appropriate signaling flags towards ACCESS.
set profiles signaling ipSignalingProfile ACCESS_IPSP ipProtocolType sipOnly set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags disableMediaLockDown enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags includeTransportTypeInContactHeader enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags reQueryPsxOnRegisterRefresh enable set profiles signaling ipSignalingProfile ACCESS_IPSP ingressIpAttributes flags sendUpdatedSDPin200Ok enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags endToEndBye enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags disableHostTranslation enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags minimizeRelayingOfMediaChangesFromOtherCallLegAll enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags relayDataPathModeChangeFromOtherCallLeg enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags dialogEventPackage enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags info enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags notify enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags options enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags refer enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags statusCode3xx enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags statusCode4xx6xx enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes relayFlags updateWithoutSdp enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes transparencyFlags authcodeHeaders enable set profiles signaling ipSignalingProfile ACCESS_IPSP egressIpAttributes flags disable2806Compliance enable set profiles signaling ipSignalingProfile ACCESS_IPSP egressIpAttributes sipHeadersAndParameters flags endToEndAck enable set profiles signaling ipSignalingProfile ACCESS_IPSP egressIpAttributes flags sameCallIdForRequiredAuthorization enable set profiles signaling ipSignalingProfile ACCESS_IPSP egressIpAttributes privacy transparency enable set profiles signaling ipSignalingProfile ACCESS_IPSP ingressIpAttributes flags sendSdpInSubsequent18x enable set profiles signaling ipSignalingProfile ACCESS_IPSP ingressIpAttributes flags suppress183WithoutSdp enable set profiles signaling ipSignalingProfile ACCESS_IPSP ingressIpAttributes flags suppress183For3xxRedirectResponse enable sendSdpIn200OkIf18xReliable enable set profiles signaling ipSignalingProfile ACCESS_IPSP commonIpAttributes flags noPortNumber5060 enable commit set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP ipProtocolType sipOnly set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes flags disableMediaLockDown enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes flags minimizeRelayingOfMediaChangesFromOtherCallLegAll enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes flags relayDataPathModeChangeFromOtherCallLeg enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags dialogEventPackage enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags info enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags notify enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags options enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags refer enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags statusCode3xx enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags statusCode4xx6xx enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes relayFlags updateWithoutSdp enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags acceptHeader enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags authcodeHeaders enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags callInfoHeader enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags fromHeader enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags mwiBody enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags sipfragBody enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags unknownBody enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags unknownHeader enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP commonIpAttributes transparencyFlags userAgentHeader enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes flags disable2806Compliance enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes flags sameCallIdForRequiredAuthorization enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes privacy transparency enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes transport type1 udp set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes transport type2 tcp set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes transport type3 tlsOverTcp set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP egressIpAttributes transport type4 sctp set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP ingressIpAttributes flags sendSdpInSubsequent18x enable set profiles signaling ipSignalingProfile GIN_ACCESS_IPSP ingressIpAttributes flags suppress183WithoutSdp enable commit set profiles signaling ipSignalingProfile PBX123_IPSP ipProtocolType sipOnly set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes flags disableMediaLockDown enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes flags minimizeRelayingOfMediaChangesFromOtherCallLegAll enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes flags relayDataPathModeChangeFromOtherCallLeg enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags dialogEventPackage enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags info enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags notify enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags options enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags refer enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags statusCode3xx enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags statusCode4xx6xx enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes relayFlags updateWithoutSdp enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags acceptHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags authcodeHeaders enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags callInfoHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags fromHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags mwiBody enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags sipfragBody enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags toHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags unknownBody enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags unknownHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP commonIpAttributes transparencyFlags userAgentHeader enable set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes flags disable2806Compliance enable set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes flags sameCallIdForRequiredAuthorization enable set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes flags useCalledPartyInRequestUri enable set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes privacy transparency enable set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes transport type1 udp set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes transport type2 tcp set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes transport type3 tlsOverTcp set profiles signaling ipSignalingProfile PBX123_IPSP egressIpAttributes transport type4 sctp set profiles signaling ipSignalingProfile PBX123_IPSP ingressIpAttributes flags sendSdpInSubsequent18x enable commit
2.4 SipAdaptor Profile
Create an IP Signaling Profile with appropriate signaling flags towards ACCESS.
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 criterion 2 type header header name request-uri condition exist
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 criterion 3 type parameter parameter paramType uri name user condition exist
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 action 1 type parameter
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 action 1 operation delete
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 action 1 paramType uri
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM rule 1 action 1 to type parameter value user
set profiles signaling sipAdaptorProfile ACCESS_INPUT_SMM state enabled
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 criterion 2 type header
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 criterion 2 header name To condition exist
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 criterion 1 type message
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 criterion 1 message messageTypes request methodTypes register
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 applyMatchHeader one
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 action 1 type token operation regsub
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 action 1 to type token tokenValue urihostname
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 action 1 regexp string (?:[0-9]{1,3}\.){3}[0-9]{1,3} matchInstance all
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 2 action 1 from type value value as.iop1.broadworks.net
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 criterion 2 header name From condition exist
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 criterion 1 message messageTypes request methodTypes register
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 applyMatchHeader one
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 action 1 type token operation regsub
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 action 1 regexp string (?:[0-9]{1,3}\.){3}[0-9]{1,3} matchInstance all
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 action 1 from type value value as.iop1.broadworks.net
set profiles signaling sipAdaptorProfile SURR_REG_SMM rule 1 action 1 to type token tokenValue urihostname
set profiles signaling sipAdaptorProfile SURR_REG_SMM state enabled
commit
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 type token
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 type token
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 type token
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 token condition exist tokenType urihostname
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 token condition exist tokenType urihostname
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 3 token condition exist tokenType urihostname
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 header name Refer-To condition exist
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 header name Refer-To condition exist
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 2 header name Refer-To condition exist
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 message messageTypes request methodTypes refer
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 message messageTypes request methodTypes refer
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 criterion 1 message messageTypes request methodTypes refer
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 applyMatchHeader one
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 applyMatchHeader one
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 action 1 type token operation modify
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 action 1 type token operation modify
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 action 1 type token operation modify
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 action 1 to type token tokenValue urihostname
set profiles signaling sipAdaptorProfile Refer_SMM rule 1 action 1 from type value value as.iop1.broadworks.net
commit
set profiles signaling sipAdaptorProfile Refer_SMM state enabled advancedSMM disabled
commit
2.5 SipParamFilterProfile
This configuration provides for pass-through of all supported sipHeaders. Attach it to both Trunk Groups.
set profiles services sipParamFilterProfile CORE_PROF sipHeader supported action passthru all commit
2.6 Prefix Profile
Create Prefix Profile with appropriate dial plan for handling outgoing calls.
This Access dial plan places all dialing patterns into username routing.
set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 0 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 0 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 1 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 1 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 2 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 2 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 3 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 3 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 4 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 4 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 5 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 5 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 6 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 6 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 7 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 7 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 8 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 8 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 9 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry 9 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry * 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry * 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry + 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry + 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry % 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry % 0 1 31 digitType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry "#" 0 1 31 callType userName set profiles digitParameterHandling prefixProfile ACCESS_DIAL_PLAN entry "#" 0 1 31 digitType userName commit
2.7 Numbering Plan
Create a Numbering Plan by applying Prefix Profile created earlier.
set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN prefixProfile ACCESS_DIAL_PLAN set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths nationalNumber min 1 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths nationalNumber max 31 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths subscriberNumber min 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths subscriberNumber max 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths line min 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths line max 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths exchangeCode min 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths exchangeCode max 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths areaCode min 0 set profiles digitParameterHandling numberingPlan ACCESS_NUM_PLAN lengths areaCode max 0 commit
2.8 Digit Manipulation/Parameter Manipulation
Create a DM/PM rule to ignore the user=phone parameter. This allows the SBC to support both Called Number and Username Routing.
set profiles digitParameterHandling dmPmRule DMPM_RULE subRule 0 ruleType uri uriParameterManipulation uriType calledUri uriParameterManipulation userParameter ip
2.9 Element Routing Priority
The Element Routing Priority (ERP) Profile determines the priority or precedence for criteria used for call routing, and then applies an ERP to the Trunk Group entity.
When configuring a Trunk Group to Trunk Group, the SBC must have an ERP profile which prioritizes the Trunk Group entity above others. This allows routing of traffic from the ingress Trunk Group to the egress Trunk Group.
set profiles callRouting elementRoutingPriority TG_ERP entry _private 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry nationalOperator 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry localOperator 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry nationalType 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry internationalType 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry internationalOperator 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry longDistanceOperator 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry ipVpnService 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry test 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry transit 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry otherCarrierChosen 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry carrierCutThrough 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry userName 1 entityType trunkGroup set profiles callRouting elementRoutingPriority TG_ERP entry mobile 1 entityType trunkGroup commit
2.10 Transparency Profile (TP)
Create an IP Signaling Profile with appropriate signaling flags towards ACCESS.
set profiles services transparencyProfile ACCESS_TP sipHeader all set profiles services transparencyProfile ACCESS_TP sipMessageBody all set profiles services transparencyProfile ACCESS_TP sipHeader supported set profiles services transparencyProfile ACCESS_TP sipHeader via ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader expires ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader contact ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader path ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader serviceroute ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader require ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader proxy-Require ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader event ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader min-se ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP sipHeader session-expires ignoreTransparency yes set profiles services transparencyProfile ACCESS_TP state enabled commit set profiles services transparencyProfile GIN_TP sipHeader all set profiles services transparencyProfile GIN_TP sipMessageBody all set profiles services transparencyProfile GIN_TP sipHeader supported set profiles services transparencyProfile GIN_TP sipHeader via ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader expires ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader contact ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader path ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader serviceroute ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader require ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader proxy-Require ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader event ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader min-se ignoreTransparency yes set profiles services transparencyProfile GIN_TP sipHeader session-expires ignoreTransparency yes set profiles services transparencyProfile GIN_TP state enabled commit set profiles services transparencyProfile PBX_TP sipHeader all set profiles services transparencyProfile PBX_TP sipMessageBody all set profiles services transparencyProfile PBX_TP sipHeader supported set profiles services transparencyProfile PBX_TP sipHeader via ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader expires ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader contact ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader path ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader serviceroute ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader require ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader proxy-Require ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader event ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader min-se ignoreTransparency yes set profiles services transparencyProfile PBX_TP sipHeader session-expires ignoreTransparency yes set profiles services transparencyProfile PBX_TP state enabled commit
2.11 IP Interface Group
Create an IP interface group.
Replace "x.x.x.x" with the SBC's packet interface (pkt) IP address towards ACCESS (example pkt0 IP), and "Y" with its prefix length. Provide ceName used during an SBC deployment.
Here the ceName is "IOTCOMCAST".
set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 ceName IOTCOMCAST set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 portName pkt0 set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 ipAddress x.x.x.x set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 prefix 24 set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 altIpAddress fc00::44:x:x:x:x set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 altPrefix 64 set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 vlanTag 444 set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 mode inService set addressContext default ipInterfaceGroup ACCESS_LIF ipInterface IPIF0 state enabled
2.12 Surrogate registration Profile
Create a surrogate registration profile for surrogate registered end points. Create the profile with the pilot number configured in BroadWorks.
set profiles services surrogateRegistrationProfile SURR_PROF aorUserName 9000090000 commit set profiles services surrogateRegistrationProfile SURR_PROF aorUserName 9000090000 aorState enabled commit
2.13 Zone
Create Zone towards ACCESS and specify the id of the zone.
This Zone groups the set of objects used for the communication towards ACCESS .
set addressContext default zone ACCESS id 2 commit set addressContext default zone GIN_ACCESS id 4 remoteDeviceType accessDevice commit set addressContext default zone PBX_ZONE id 5 commit
2.14 SIP Signaling Port
Set the SIP Signaling port, which is a logical address used to send and receive SIP call signaling packets, and is permanently bound to a specific zone.
Replace "x.x.x.x" with SIP Signaling Port IP of SBC towards ACCESS.
set addressContext default zone ACCESS sipSigPort 2 ipInterfaceGroupName ACCESS_LIF set addressContext default zone ACCESS sipSigPort 2 ipAddressV4 x.x.x.x set addressContext default zone ACCESS sipSigPort 2 ipAddressV6 fc00::44:x:x:x:x set addressContext default zone ACCESS sipSigPort 2 mode inService set addressContext default zone ACCESS sipSigPort 2 state enabled set addressContext default zone ACCESS sipSigPort 2 dscpValue 26 set addressContext default zone ACCESS sipSigPort 2 transportProtocolsAllowed sip-udp,sip-tcp set addressContext default zone GIN_ACCESS id 4 remoteDeviceType accessDevice commit set addressContext default zone GIN_ACCESS sipSigPort 4 ipInterfaceGroup ACCESS_LIF set addressContext default zone GIN_ACCESS sipSigPort 4 ipAddressV4 x.x.x.x set addressContext default zone GIN_ACCESS sipSigPort 4 dscpValue 26 set addressContext default zone GIN_ACCESS sipSigPort 4 transportProtocolsAllowed sip-udp,sip-tcp set addressContext default zone GIN_ACCESS sipSigPort 4 state enabled mode inService commit set addressContext default zone PBX_ZONE sipSigPort 5 ipInterfaceGroup ACCESS_LIF set addressContext default zone PBX_ZONE sipSigPort 5 ipAddressV4 x.x.x.x set addressContext default zone PBX_ZONE sipSigPort 5 dscpValue 26 set addressContext default zone PBX_ZONE sipSigPort 5 transportProtocolsAllowed sip-udp,sip-tcp set addressContext default zone PBX_ZONE sipSigPort 5 state enabled mode inService commit
2.15 IP Peer
Create an IP Peer with the signaling IP address of the ACCESS(Service Provider) and assign it to the ACCESS Zone.
Replace "x.x.x.x" with the ACCESS IP.
set addressContext default zone ACCESS ipPeer SURR_PEER ipAddress 10.x.x.x ipPort 5060 commit set addressContext default zone ACCESS ipPeer SURR_PEER surrogateRegistration surrRegProfile SURR_PROF hostPart stbroadsoft.com commit set addressContext default zone ACCESS ipPeer SURR_PEER surrogateRegistration surrRegProfile SURR_PROF state enabled commit
2.16 IP Signaling Peer Group
When BroadWorks provides the destination Trunk Group (Via the DTG parameter) to the SBC, an IP Signaling Peer Group must be configured rather than an IP Peer. This is because only the IP Signaling Peer Group parameter is directly associated with a Trunk Group.
set profiles ipSignalingPeerGroup PBX123_IPSG description "IP-PBX for BW Trunking Example" set profiles ipSignalingPeerGroup PBX123_IPSG ipSignalingPeerGroupData 1 ipAddress 10.54.20.168 ipPort 5070 set profiles ipSignalingPeerGroup PBX123_IPSG ipSignalingPeerGroupData 1 serviceStatus inService commit
2.17 SIP Trunk Group
Create a SIP Trunk Group towards the ACCESS and assign corresponding profiles like LRBT, PSP, IPSP created in earlier steps.
You must configure Trunk Group names using capital letters.
set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG media mediaIpInterfaceGroupName ACCESS_LIF set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG media lateMediaSupport passthru sourceAddressFiltering enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG media mediaAddrType matchSigAddrType set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG media sdpAttributesSelectiveRelay enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy digitParameterHandling numberingPlan ACCESS_NUM_PLAN set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy callRouting elementRoutingPriority TG_ERP set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy media packetServiceProfile ACCESS_PSP set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy signaling ipSignalingProfile ACCESS_IPSP set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy signaling signalingProfile DEFAULT_IP_PROFILE set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services dnsSupportType a-srv-naptr set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services natTraversal signalingNat enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services natTraversal mediaNat enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services natTraversal qualifiedPrefix x.x.x.x commit set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling messageManipulation inputAdapterProfile ACCESS_INPUT_SMM set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling relayNonInviteRequest enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling registration requireRegistration required set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling registration expires 3600 set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling registration insideExpiresMinimum 3500 set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling rel100Support disabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling psxRouteForSubscribe enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG policy digitParameterHandling ingressDmPmRule DMPM_RULE set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG ingressIpPrefix 0.0.0.0 0 set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services transparencyProfile ACCESS_TP set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG media sdpAttributesSelectiveRelay enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG state enabled mode inService commit set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG media mediaIpInterfaceGroupName ACCESS_LIF set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG media sourceAddressFiltering disabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG policy digitParameterHandling numberingPlan ACCESS_NUM_PLAN set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG policy callRouting elementRoutingPriority TG_ERP set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG policy media packetServiceProfile GIN_ACCESS_PSP set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG policy signaling ipSignalingProfile GIN_ACCESS_IPSP set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG policy signaling signalingProfile DEFAULT_IP_PROFILE set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG services dnsSupportType a-srv-naptr set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG services natTraversal signalingNat enabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG services natTraversal mediaNat enabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling registration requireRegistration required-group set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling registration bulkRegisterFormat enabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling registration expires 3600 set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling registration insideExpiresMinimum 3500 set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling rel100Support disabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling relayNonInviteRequest enabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling psxRouteForSubscribe enabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG signaling validateAor disabled set addressContext default zone GIN_ACCESS sipTrunkGroup GIN_ACCESS_STG ingressIpPrefix 0.0.0.0 0 set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG media mediaIpInterfaceGroupName ACCESS_LIF set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG media sourceAddressFiltering disabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy sipDomain AS.IOP1.BROADWORKS.NET set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy digitParameterHandling numberingPlan ACCESS_NUM_PLAN set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy callRouting elementRoutingPriority TG_ERP set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy ipSignalingPeerGroup PBX123_IPSG set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy media packetServiceProfile PBX123_PSP set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy signaling ipSignalingProfile PBX123_IPSP set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG policy signaling signalingProfile DEFAULT_IP_PROFILE set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG services dnsSupportType a-srv-naptr set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG services natTraversal signalingNat enabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG services natTraversal mediaNat enabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG signaling rel100Support disabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG signaling relayNonInviteRequest enabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG signaling psxRouteForSubscribe enabled set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG ingressIpPrefix 0.0.0.0 0 commit set addressContext default zone PBX_ZONE sipTrunkGroup PBX123_TG state enabled mode inService commit for surrogate call: set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG signaling registration requireRegistration supported commit
CORE Leg Configuration
Create entities with a specific set of characteristics corresponding to CORE. This includes configuration of the following on CORE leg:
- Packet Service Profile
- IP Signaling Profile
- Feature Control Profile
- ARSProfile
- Dns group
- Transparency profile
- IP Interface Group
- Zone
- SIP Signaling Port
- IP Peer
- SIP Trunk Group
3.1 Packet Service Profile (PSP)
Create a Packet Service Profile (PSP) for the CORE leg. The PSP is attached to the sipTrunkGroup that is created later in this section.
set profiles media packetServiceProfile CORE_PSP codec codecEntry1 G729AB-DEFAULT set profiles media packetServiceProfile CORE_PSP codec codecEntry2 G711_ALAW_PTIME_20 commit set profiles media packetServiceProfile CORE_PSP packetToPacketControl transcode transcoderFreeTransparency set profiles media packetServiceProfile CORE_PSP rtcpOptions rtcp enable set profiles media packetServiceProfile CORE_PSP videoCalls maxVideoBandwith 4096 commit
3.2 IP Signaling Profile (IPSP)
Create an IP Signaling Profile with appropriate signaling flags towards CORE.
set profiles signaling ipSignalingProfile CORE_IPSP ipProtocolType sipOnly set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags disableHostTranslation enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags disableMediaLockDown enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags includeTransportTypeInContactHeader enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags reQueryPsxOnRegisterRefresh enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags endToEndBye enable set profiles signaling ipSignalingProfile CORE_IPSP ingressIpAttributes flags sendUpdatedSDPin200Ok enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags minimizeRelayingOfMediaChangesFromOtherCallLegAll enable relayDataPathModeChangeFromOtherCallLeg enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags dialogEventPackage enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags info enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags notify enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags refer enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags statusCode4xx6xx enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes relayFlags updateWithoutSdp enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes transparencyFlags authcodeHeaders enable set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes flags disable2806Compliance enable set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes sipHeadersAndParameters flags endToEndAck enable set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes flags sameCallIdForRequiredAuthorization enable set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes privacy transparency enable set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes transport type1 udp set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes transport type2 tcp set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes transport type3 tlsOverTcp set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes transport type4 sctp set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes flags suppressUnregister enable set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes flags noPortNumber5060 enable commit set profiles signaling ipSignalingProfile CORE_IPSP commonIpAttributes transparencyFlags contactHeader enable commit
3.3 Feature Control profile (FCP)
Create a Feature Control Profile with appropriate signaling flags towards CORE.
set profiles featureControlProfile CORE_FCP processDestinationTgrp enable commit
3.4 Address reachability Service (ARS) Profile
To achieve efficient device failover to the backup/secondary Application Server, the SBC uses the Address Reachability Service (ARS) to determine if a server is reachable, providing the ability to “blacklist” a server IP address if it is found to be unreachable, as well as the ability to Remove the server from the blacklisted state.
ARS will be triggered based on the SIP-INVITE timeout, so if other requests like SUBSCRIBE, REGISTER are sent to that peer, then ARS will not be triggered.
ARS profile is suitable for the peer which is used only for INVITE.
set profiles services sipArsProfile CORE_ARSP blkListAlgorithms timeouts,retryafter set profiles services sipArsProfile CORE_ARSP blkListAlgTimeoutsType sip-invite set profiles services sipArsProfile CORE_ARSP blkListAlgTimeoutsNumTimeouts 4 set profiles services sipArsProfile CORE_ARSP blkListAlgTimeoutsDuration 120 set profiles services sipArsProfile CORE_ARSP blkListAlgRetryAfterType sip-503 set profiles services sipArsProfile CORE_ARSP recoveryAlgorithm probe set profiles services sipArsProfile CORE_ARSP recoveryAlgProbeInterval 30 set profiles services sipArsProfile CORE_ARSP recoveryAlgProbeNumResponses 6 set profiles services sipArsProfile CORE_ARSP recoveryAlgProbeDuration 240 commit
3.5 DNS group
Create a DNS group with appropriate signaling flags towards CORE.
set addressContext default dnsGroup CORE_DNS_GRP type mgmt set addressContext default dnsGroup CORE_DNS_GRP interface mgmtGroup set addressContext default dnsGroup CORE_DNS_GRP server EXTERNAL_DNS state enabled set addressContext default dnsGroup CORE_DNS_GRP server EXTERNAL_DNS ipAddress x.x.x.x set addressContext default dnsGroup CORE_DNS_GRP server EXTERNAL_DNS priority 80 set addressContext default dnsGroup CORE_DNS_GRP server EXTERNAL_DNS weight 50
3.6 Transparency profile (TP)
Create a Transparency Profile (TP) for the BroadWorks Core. The TP will be specified within the SIP Trunk Group configuration.
For BroadWorks, this profile is configured to make the Call Headers transparent, and exceptions will be added for the headers that will not be transparent.
set profiles services transparencyProfile CORE_TP sipHeader all set profiles services transparencyProfile CORE_TP sipMessageBody all set profiles services transparencyProfile CORE_TP sipHeader supported set profiles services transparencyProfile CORE_TP sipHeader via ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader expires ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader contact ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader path ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader serviceroute ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader require ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader proxy-Require ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader event ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader min-se ignoreTransparency yes set profiles services transparencyProfile CORE_TP sipHeader session-expires ignoreTransparency yes set profiles services transparencyProfile CORE_TP state enabled commit
3.7 IP Interface Group
Create an IP interface group.
Replace "x.x.x.x" with the SBC's packet interface (pkt) IP address towards CORE (example pkt1 IP), and "Y" with its prefix length. Provide the ceName used during an SBC deployment.
Here the ceName is "IOTCOMCAST".
set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 ceName IOTCOMCAST set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 portName pkt1 set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 ipAddress x.x.x.x set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 prefix 24 set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 altIpAddress fd00:10:x:x::x set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 altPrefix 6 set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 vlanTag 445 set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 mode inService set addressContext default ipInterfaceGroup CORE_LIF ipInterface IPIF2 state enabled
3.8 Zone
Create a Zone towards CORE and specify the id of the zone.
This Zone groups the set of objects used for communication towards Zoom.
set addressContext default zone CORE id 2 commit
3.9 SIP Signaling Port
Set the SIP Signaling port, which is a logical address used to send and receive SIP call signaling packets and is permanently bound to a specific zone.
Replace "x.x.x.x" with the SIP Signaling Port IP address of the SBC towards CORE.
set addressContext default zone CORE sipSigPort 3 ipInterfaceGroupName CORE_LIF set addressContext default zone CORE sipSigPort 3 ipAddressV4 x.x.x.x set addressContext default zone CORE sipSigPort 3 ipAddressV6 fd00:10:x:x::x set addressContext default zone CORE sipSigPort 3 mode inService set addressContext default zone CORE sipSigPort 3 state enabled set addressContext default zone CORE sipSigPort 3 dscpValue 26 set addressContext default zone CORE sipSigPort 3 transportProtocolsAllowed sip-udp,sip-tcp
3.10 IP Peer
Create an IP Peer with the signaling IP address of CORE and assign it to CORE Zone.
Replace "x.x.x.x" with the CORE SIP signaling IP.
set addressContext default zone CORE ipPeer CORE_PEER policy sip fqdn ns1.stbroadsoft.com set addressContext default zone CORE ipPeer CORE_PEER policy sip fqdnPort 5060 commit
3.11 SIP Trunk Group
Create a SIP Trunk Group towards CORE and assign corresponding profiles like LRBT, PSP, IPSP that were created in earlier steps.
You must configure Trunk Group names using capital letters.
set addressContext default zone CORE sipTrunkGroup CORE_STG media mediaIpInterfaceGroupName CORE_LIF set addressContext default zone CORE sipTrunkGroup CORE_STG media lateMediaSupport passthru sourceAddressFiltering enabled set addressContext default zone CORE sipTrunkGroup CORE_STG media mediaAddrType matchSigAddrType set addressContext default zone CORE sipTrunkGroup CORE_STG media sdpAttributesSelectiveRelay enabled set addressContext default zone CORE sipTrunkGroup CORE_STG policy digitParameterHandling numberingPlan ACCESS_NUM_PLAN set addressContext default zone CORE sipTrunkGroup CORE_STG policy callRouting elementRoutingPriority TG_ERP set addressContext default zone CORE sipTrunkGroup CORE_STG policy media packetServiceProfile CORE_PSP set addressContext default zone CORE sipTrunkGroup CORE_STG policy signaling ipSignalingProfile CORE_IPSP set addressContext default zone CORE sipTrunkGroup CORE_STG signaling messageManipulation outputAdapterProfile Refer_SMM set addressContext default zone CORE sipTrunkGroup CORE_STG policy signaling signalingProfile DEFAULT_IP_PROFILE set addressContext default zone CORE sipTrunkGroup CORE_STG services dnsSupportType a-srv-naptr set addressContext default zone CORE sipTrunkGroup CORE_STG services sipArsProfile CORE_ARSP set addressContext default zone CORE sipTrunkGroup CORE_STG signaling relayNonInviteRequest enabled set addressContext default zone CORE sipTrunkGroup CORE_STG signaling retryCounters general 4 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling retryCounters invite 2 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling retryCounters bye 2 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling retryCounters cancel 2 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling retryCounters reInvite 2 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling timers sessionMinSE 60 set addressContext default zone CORE sipTrunkGroup CORE_STG signaling registration bulkRegisterFormat followIngress set addressContext default zone CORE sipTrunkGroup CORE_STG signaling registration insideExpiresMinimum 3500 set addressContext default zone CORE sipTrunkGroup CORE_STG ingressIpPrefix 0.0.0.0 0 set addressContext default zone CORE sipTrunkGroup CORE_STG services sipParamFilterProfile CORE_PROF set addressContext default zone CORE sipTrunkGroup CORE_STG signaling honorMaddrParam enabled set addressContext default zone CORE sipTrunkGroup CORE_STG services transparencyProfile CORE_TP set addressContext default zone CORE sipTrunkGroup CORE_STG policy featureControlProfile CORE_FCP set addressContext default zone CORE sipTrunkGroup CORE_STG signaling messageManipulation outputAdapterProfile SURR_REG_SMM set addressContext default zone CORE sipTrunkGroup CORE_STG state enabled mode inService commit
Static Routes Configuration
Static routes are used to create communication to remote networks. In a production environment, static routes are mainly configured for routing from a specific network to a network that can only be accessed through one point or one interface (single path access or default route).
Tip
- For smaller networks with just one or two routes, configuring static routing is preferable. This is often more efficient since a link does not get wasted by exchanging dynamic routing information.
- For networks that have a LAN-side Gateway on Voice VLAN or Multi-Switch Edge Devices (MSEs) with Voice VLAN towards SBC Core, static routing configurations are not required.
Add the static route once ACCESS Leg and CORE Leg configurations are done on the SBC.
Static route towards ACCESS
set addressContext default staticRoute 0.0.0.0 0 10.54.X.X LIF1 PKT0_V4 preference 100 commit
Static route towards CORE
set addressContext default staticRoute 10.54.X.X 24 10.54.X.X LIF2 PKT1_V4 preference 100 commit set addressContext default staticRoute fd00:10:X:X::36 64 fd00:10:X:X::36 LIF2 PKT1_V4 preference 100 commit
Global Call Routing Configuration
A Routing Label (RL) is a new user-named object that contains a list of one or more next-hop peers – defined as Routing Label Routes – that can reach a specified destination.
A Routing Label Route (RLR) defines a single peer (Trunk Group + IP Peer) to which the call can be delivered. There may be many Routing Label Routes (1 to n) in a Routing Label.
For each call placed to a destination Routing Label, the SBC will advance through the list of peers (RLRs) until the call is completed or the list is exhausted. The RL’s Prioritization Type determines the order in which the list will be processed.
Routing Labels are then assigned within the Route entity.
4.1 CORE_RL
4.1.1 Routing Label
Create a Routing Label with a single Routing Label Route to bind the Core Trunk Group with the Core IP Peer.
set global callRouting routingLabel CORE_RL routePrioritizationType sequence action routes routingLabelRoute 1 trunkGroup CORE_STG ipPeer CORE_PEER inService inService commit
4.1.2 Routing
Routing must be put in place to send calls to the correct destination. For the purpose of this scenario we have used trunk group routing, but additional routing options may be used.
Configuration of both standard and username routes are done to ensure that no matter which way the called party is addressed (a number or username) the SBC will route the message to the Core.
Create Route entries for standard Trunk Group routing with Matching Criteria and a Routing Label destination.
Provide ceName used during an SBC deployment. "IOTCOMCAST" is the ceName.
set global callRouting route trunkGroup ACCESS_STG IOTCOMCAST standard Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL set global callRouting route trunkGroup ACCESS_STG IOTCOMCAST username Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL set global callRouting route trunkGroup GIN_ACCESS_STG IOTCOMCAST standard Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL set global callRouting route trunkGroup GIN_ACCESS_STG IOTCOMCAST username Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL set global callRouting route trunkGroup PBX123_TG IOTCOMCAST standard Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL set global callRouting route trunkGroup PBX123_TG IOTCOMCAST username Sonus_NULL Sonus_NULL all all ALL none Sonus_NULL routingLabel CORE_RL commit
SBC configuration for Record-aware tag(Optional)
Follow below SBC configurations if SBC has to relay record-aware tag
set profiles services sipParamFilterProfile CORE_PROF sipHeader supported action passthru all set profiles services sipParamFilterProfile CORE_PROF state enabled set addressContext default zone ACCESS sipTrunkGroup ACCESS_STG services sipParamFilterProfile CORE_PROF
OTG Configuration(Optional)
Follow below SBC configurations for otg parameter
set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes sipHeadersAndParameters originatingTrunkGroupOptions includeOtg set profiles signaling ipSignalingProfile ACCESS_IPSP egressIpAttributes sipHeadersAndParameters originatingTrunkGroupOptions includeNone
TGRP Configuration(Optional)
Follow below SBC configurations for tgrp parameter
set profiles signaling ipSignalingProfile CORE_IPSP egressIpAttributes sipHeadersAndParameters originatingTrunkGroupOptions includeTgrpWithDomainName
Duplicate Register Configuration(Optional)
Follow below SBC configurations for duplicate registration
set global signaling sipSigControls registrarSupportContactParam enabled multipleContactsPerAor enabled
Surrogate Register Configuration(Optional)
set profiles services surrogateRegistrationProfile SURR_PROF aorUserName 9000090000 commit set profiles services surrogateRegistrationProfile SURR_PROF aorUserName 9000090000 aorState enabled commit set addressContext default zone ACCESS ipPeer SURR_PEER ipAddress 10.56.7.219 ipPort 5060 commit set addressContext default zone ACCESS ipPeer SURR_PEER surrogateRegistration surrRegProfile SURR_PROF hostPart stbroadsoft.com commit set addressContext default zone ACCESS ipPeer SURR_PEER surrogateRegistration surrRegProfile SURR_PROF state enabled commit
Section B: Configuration of Cisco Broadsoft
This includes configuration of the following entities on Broadworks server which are part of the Cisco Broadworks Interoperabilty test plan
- DND
- MOH
- CFNA
- RemoteRingback
- 181CallForward
- VoicePortal
- RingSplash
- PriorityAlert
- CallerID
- Anonymous
- UnicodeCharacters
- TrustedEndpoint
- DiversionHeader
- MultipleRedirects
- DenyCalls
- CallWaiting
- CallForward
- MaxRegistrationtime
- UCone
- Clicktodial
- Clicktoanswer
- ACD
- Bargein
- SecurityClassification
- VideoVoicemail
- PolycomRecording
- SharedCallAppearance
- GINRegistration
- OTG
- DTG
- TGRP
- TGRPtoIPPBX
- DuplicateRegistration
- SurrogateRegistration
- FAXVoipphone
- T38Fax
- IPV6
Accesing Broadsoft
Open any browser and enter the Broadsoft IP address and provide credentials.
DND
Go to User→ Incoming Calls→ DoNotDisturb
Music ON Hold(MOH)
Browse to <user> → Call Control → Music/Video On Hold for User A1. Make sure Music On Hold is set to “On”.
Call Forward No Answer (CFNA)
Browse to <user> → Incoming Calls → Call Forwarding No Answer for User . Make sure call forward no answer number is assigned and Number of rings before forwarding is configured.
Remote Ringback
User configured for remote ringback: 2407209061
- Browse to <user> → Profile → Announcement Repository for the called user. Select Add and upload an audio file. The audio file must be CCITT u-Law, 8 kHz, 8 bit Mono, WAV file type. Alternatively, dial into the voice portal from the user phone and follow the menu to “record a new announcement”.
- Browse to <user> → Incoming Calls → Custom Ringback User for the called user. Select Add to add a custom ringback instance. Under the General Setting tab, provide a description and select Play Custom Ringback. Set Selected Time Schedule to All Day Every Day. Select calls from Any phone number. Under the Initial Ringback tab, for Audio Ringback, select Personal Ringback File and select the uploaded or recorded announcement from the drop-down menu. The recorded announcement will have a name similar to Voice Portal.wav.
- Browse to <user> → Incoming Calls → Custom Ringback User for the called user. Make sure the Active box for the custom ringback is checked.
181 Call is being Forwarded
Browse to User → Profile → Call Policies. Set Send Call Being Forwarded Response on Redirect Calls to “All Calls”.
Configure the Call Forward Always service for BroadWorks User to forward to BroadWorks another user.
Voice portal
Browse to <user> → Messaging→ Voice Messaging for User A1 and make sure that the BroadWorks Voice Portal Calling service is assigned and set to “On
Advanced Settings→ Configure personal mail server
RingSplash
User configured:2407209062
Assign the BroadWorks Do Not Disturb service to User A1.
Enable the Do Not Disturb service and select the Play Ring Reminder when a call is blocked check box
Priority Alert Ringing
User configured:2407209063
Assign the BroadWorks Priority Alert service to User A1.
Configure the Priority Alert service to trigger on calls from User A2’s extension.
Caller ID
Make sure that the following services are assigned and enabled for User A1. These services are configured from the Incoming Calls tab for the BroadWorks user.
Browse to each service configuration page to make sure it is set to “On”.
Internal Calling Line ID Delivery
External Calling Line ID Delivery
Anonymous Call
No configured for service 2407209076
Make sure that User C1 is in a different BroadWorks group than User A1. Caller ID is not blocked if the call is within the same group.
Assign the BroadWorks Calling Line ID Blocking service to User C1.
Browse to the Outgoing Calls → Line ID Blocking page for User C1. Enable the Line ID Blocking service by selecting Block Calling Line ID on Outgoing Calls
Calling Name with Unicode Characters
User configured: 2407209064
Browse to the Profile page for BroadWorks User
Set BroadWorks User First Name to a name containing one or more Unicode characters, for example, “Björk” or “François”.
Set BroadWorks User A2’s Last Name to a name containing one or more Unicode characters, for example, “Guðmundsdóttir” or “Saint-Saëns”.
Calling Name and Number, Trusted Endpoint
User configured: 2407209068
Browse to the Profile page for BroadWorks User and verify the Calling Line ID name.
Make sure the Trusted option is selected on the device identity/profile for the BroadWorks device type assigned to the DUT. If it is not, create an identical device
profile with the Trusted option selected and assign it to the trunk group
Goto System-- > Identity Device profile Type → Enable Trusted
Goto Device Profile→ Create new profile and assign profile type with "Trusted"
Goto user→ Addressess→ Assign profile created in above step
Diversion Header
Browse to the System → Resources → Identity/Device Profile Type Modify page for the device type assigned to User A1. Make sure that Use History Info Header is not
checked.
Configure the Call Forward Always service for User B1 to forward to User A1.
Number configured: 2407209069
Diversion Header: Multiple Redirects
Browse to the System → Resources → Identity/Device Profile Type Modify page for the device type assigned to User . Make sure that Use History Info Header is not checked.
Configure the Call Forward Always service for User B1 to forward to User C1.
Configure the Call Forward Always service for User C1 to forward to User A1.
Number configured: 2407209070
Deny Calls from Unregistered Users
Enable the Deny Calls from Unregistered Users via the Application Server CLI as shown in the following.
AS_CLI/System/Registration> set denyCallsFromUnregisteredUsers true
Call Waiting
Number configured: 2407209065
Number configured: 2407209066
Goto user → Callcontrol→ Call Waiting→ On
Call Forward
Number configured:2407209069
Goto user→ Incoming Calls→ Call Forwarding Always
Maximum Registration Time
Assign the BroadWorks Authentication service to User A1.
Configure the BroadWorks Authentication service with the authentication user name and password.
Configure User A1’s device with matching the authentication user name and password.
Check for registrations as below
Configure the maximum registration time via the BroadWorks Application Server CLI as “3600” seconds as shown in the following example.
AS_CLI/System/Registration> set maxRegistrationTimeInSeconds 3600
Configure the peer registration time on the DUT to “7200” seconds. This is the registration expiration the SBC/ALG sends to the BroadWorks Application Server.
UC one client configuration
Steps to convert broadsoft users as UC-one communicator clients
Create Identity device profile for each user
- Go to 'System' and then 'Resources' and then 'Identity device profile'
- Add a new Identity device profile. It's recommended to create one Identity device profile for each UC-One client
- Assign Identify device profile type as "Business communicator - PC" for desktop clients - which we use in general
- Assign a password for each client login. Make sure user-id matches with the one already configured for that specific broadsoft user (found in Profile section for each user)
Assign Identity device profile for each user
- Go to 'user' and then search for that user
- Click the specific user which need to be converted to UC-one client
- Go to 'Profile' and then 'Addresses' and then assign a Identity device profile configured in above step and then click 'apply'
- Click 'configure Identity device profile' link and then go to "Custom Tags"
- In Custom Tags, add a tag "SBC_ADDRESS" and then input the IP address of broadworks application server or SBC SIP Signaling IP address (based on individual requirement)
- Click "Files" tab and then click the link "Rebuild the files (force)"
UC One Communicator Client side
- On the client side, open the communicator client app
- Type the server address as XSP server IP. In corporate broadsoft, server address has to be http://10.54.181.57/
- Go to Options and then Advanced and then click "Show Logs" and it will open the directory on desktop / laptop . Path will contain \\\\BroadSoft\Communicator\logs
- Go to Communicator folder in above path and then copy two files "application_setting" and "proxy_settings" (attached in this wiki below)
- Type the username and password configured on broadsoft application server
- It should show option to make or receive call if login credentials are correct
Files for UC-One communicator client
proxy_settings (1).iniapplication_setting (1) (1).ini
Here is the link to the latest version:
Windows: https://xchange.broadsoft.com/node/1059464
MAC: https://xchange.broadsoft.com/node/1059463
Click to answer on UC one client
- BusinessCommunicatornew files and authentication tab
- Once users are associated with device profiles , below is url to login using UC one client
BroadWorks sends the DUT a NOTIFY with the Event header set to “talk”.
Login url on UC one client: https://xsp01.stbroadsoft.com:443/dms/bc/dt/config.xml
bsft-testuser96@stbroadsoft.com
passwd:Broadsoft@1
ACD feature configuration on polycom phones
Follow below phone config for ACD feature on polycom phones
Barge in polycom config file
Follow below phone config for barge in feature on polycom phones
Security Classifications
Security classifications subscribe is enabled for 2407209066
polycom cfg file
This is new feature implemented on polycom phones with help of document provided by TAC team.
Attached is config and document
Video Voicemail
Video voicemail configured number 2407209061 and worked on kapanga softphone
Recording
During recording, kindly follow SBC configuration for Record-aware tag(Optional) asSBC has to relay record-aware tag for Recording feature.
During this Interop, Recorder ip 10.54.xx.xx (IOT BATS Server IP) with port number 18096 has been configured on Broadworks to handle the recording.
Below 2 numbers services were assigned and used
2407209024, 2407209025
Follow below Broadsoft cli configurations to setup recording server ip
Record-aware tag
AS_CLI/Service/CallRecording/Platform> g System default Call Recording platform = platformA Name Net Address Port Transport Type Media Stream Schema Version Support Video Rec Description Route ========================================================================================================================= platformA 10.54.81.77 18096 UDP Single 3.0 true RecordingDeviceFQDN
Broadsoft GUI configuration for number 2407209024
Goto user→ Call Control→Call Recording
Below is polycom phone config file
Shared Call Appearance
Broadsoft configured number for shared call appearance : 2407209065
GIN Registration
No used for configuration : 30003000
- Created Identity Profile - PBX-USER
- Created Trunk Group → with that identity profile + PILOT NO 30003000
- User search identified 2407209091 and attached that Trunk Group which is already mapped to a PILOT NO 30003000
OTG configuration
Below are numbers configured for otg
2407209999—from number
2407209066—registered to broadsoft via sbc
OTG is working with below configuration
Follow SBC OTG configuration for enabling Otg parameter on SBC
DTG configuration
Make call from 2407209066 to 2407209098
Follow below steps for enabling Dtg parameter on Broadsoft
TGRP configuration
Follow TGRP configuration steps on SBC to configure TGRP parameter.
Follow below steps on broadsoft to configure tgrp parameter.
Below were changes done to make tgrp work
Any random number needs to be given in calling line id group number and below cli configurations had to be done.
AS server config
AS_CLI/System/Registration> get extensionTimeInSeconds = 2400 postUpgradeExtensionTimeInSeconds = 97200 maxRegistrationTimeInSeconds = 3600 denyCallsFromUnregisteredUsers = true minRegistrationTimeInSeconds = 1200 enableMinRegistrationTime = true enforceMinRegistrationTime = tru captureViaHeader = false captureAccessInfoInPaniHeader = false persistExpiredRegistrationData = false AS_CLI/System/Registration> set denyCallsFromUnregisteredUsers false ...Done
TGRP to IP PBX
Test setup:
On the Profile page, configure the Trunk Group Identity (for example, trunkgroupB@192.168.40.14), where trunkgroupB is the TGRP value and 192.168.40.14 is the trunk-context value.
Expected result
===========
Need to get below parameter in request uri from Broadsoft
TGRP
250 08312021 154049.118930:1.01.00.35232.Info .SIPCM: *Receive Msg From: 10.54.181.51/5060, len: 1139, sigPort: 3, socket: 109, INVITE sip:80008000;tgrp=ACCESS_STG;trunk-context=stbroadsoft.com@10.34.45.15:5060;dtg=ACCESS_STG;reg-info=a04 SIP/2.0 msg = INVITE sip:80008000;tgrp=ACCESS_STG;trunk-context=stbroadsoft.com@10.34.45.15:5060;dtg=ACCESS_STG;reg-info=a04 SIP/2.0 Via:SIP/2.0/UDP 10.54.181.51;branch=z9hG4bKBroadWorks.2rjdj-10.34.45.15V5060-0-232280144-135392673-1630404649119- From:"bsft testuser66"sip:2407209066@stbroadsoft.com;user=phone;tag=135392673-1630404649119- To:"bsft testuser96"sip:2407209096@stbroadsoft.com;dtg=ACCESS_STG;reg-info=a04 Call-ID:BW1540491193108211513595669@10.54.181.51 CSeq:232280144 INVITE Contact:sip:stbroadsoft.com
Make call from 2407209065 to 2407209096
Duplicate Registration
Two devices should be registered to different line/port (i.e., one device is register to primary device, and another is on an SCA device) so two endpoints registered should be 2407209065 and 2407209065_1.
Follow SBC configuration for Duplicate Register to work
Surrogate Register
Surrogate user no:2407209093
Pilot no:9000090000
Broadsoft config:
Follow SBC configuration for Surrogate register.
FAX VOIP softphone configuration
Required fax configurations are done for T.38 cases for following numbers:
2407209065
2407209077
Broadsoft configuration for fax messaging number:
Go to user 2407209077 → Messaging→Fax messaging
Dial 2407209056 number from 2407209065 and send fax
ADS – T38 Fax Messaging: Terminating (P0)
Dial voice portal number 2407209000 from 2407209077 and follow instructions to print fax
Broadsoft configurations:
IPV6 configuration
DNS Configuration
Adding DNS entries on DNS server to resolve ipv6 addresses of Broadsoft servers
"stbroadsoft.com IN AAAA fd00:10:6b50:4b00::33" "ns1 IN AAAA fd00:10:6b50:4b00::36"
Network Server Configuration
Changes to be done on Network server to support ipv6 configuration
NS_CLI> cd System/Device/HostingNE/Address HostingNe NodeID Address type cost weight port transport ======================================================================================= bwas1 0 as01 Alias - - - - bwas1 0 as01.stbroadsoft.com DualRouting 1 99 5060 unspecified bwas1 0 as1.stbroadsoft.com Alias - - - - bwas1 1 as02 Alias - - - - bwas1 1 as02.stbroadsoft.com Alias - - - - bwas1 1 as2.stbroadsoft.com Alias - - - - 6 entries found.
NS_CLI/System/Device/HostingNE> get Hosting Network Element NILL_HOSTING_NE Type = other Profile = NIL_PROFILE Default Enterprise = NIL_ENTERPRISE Default Routing Enterprise = NIL_ENTERPRISE Default Site = DFLT_SITE Default Routing Site = DFLT_SITE Poll = false OpState = enabled State = OnLine Signaling Attributes = Country Code = 218 XSP Version Equal = false Cluster Type = primarySecondary User Capacity (thousands) = 999999 Hosting NE Capabilities = Signal Cic Added As Cac To AS = false Support Location-Based Services = false Failover Data Center Mode = All Failover Single Data Center ID = Slice ID = Hosting Network Element bwas1 Type = broadworks Profile = NIL_PROFILE Default Enterprise = NIL_ENTERPRISE Default Routing Enterprise = NIL_ENTERPRISE Default Site = DFLT_SITE Default Routing Site = DFLT_SITE Poll = true OpState = disabled State = OnLine Signaling Attributes = SIPIPv4NotSupported Country Code = 1 XSP Version Equal = true Cluster Type = primarySecondary User Capacity (thousands) = 10000 Hosting NE Capabilities = ProvisioningCapable, CallProcessingCapable Signal Cic Added As Cac To AS = false Support Location-Based Services = false Failover Data Center Mode = All Failover Single Data Center ID = Slice ID = 2 entries found
NS_CLI/System/Device/HostingNE/Address> cd /Interface/SIP/ NS_CLI/Interface/SIP> get SIP configuration ================= listeningPort = 5060 T1 = 500 T2 = 4000 GlobalCicEnabled = false q minimum = 0 q maximum = 0.5 useViaHost = true useDNSLookup = false sendLata = false symmetricSignaling = false supportTcp = true supportDnsNaptr = false sendE164 = true maxNumberTcpSocketsPerSystem = 1000 maxNumberTcpSocketsPerPeer = 100 autoDiscardStaleConnections = false staleConnectionTimerInMinutes = 60 addCICInSourceId= false sendReasonHeader= false IMSApplication= false BEAApplication= false supportRFC3966PhoneContext= false redirectNumNonCallThreads = 3 redirectNumCallThreads = 3 sipNumNonCallReceiveThreads = 3 sipNumCallReceiveThreads = 3 sipNumEncoderThreads = 3 useSessionCompletionTimer = true sessionCompletionTimerMillis = 5000 udpReceiveBufferSize = 1048576 sipIpVersion = both viaHost = includeRouteInContact = false
NS_CLI/Interface/SIP> cd /System/StartupParam NS_CLI/System/StartupParam> get publicIPAddress = 10.54.181.54 publicIPv6Address = <nil> NS_CLI/System/StartupParam> set publicIPv6Address fd00:10:6b50:4b00::36 Changed 'publicIPv6Address' from <nil> to fd00:10:6b50:4b00::36 Note: new property values take effect after application restart NS_CLI/System/StartupParam> get publicIPAddress = 10.54.181.54 publicIPv6Address = fd00:10:6b50:4b00::36 NS_CLI/Interface/SIP> set sipIpVersion IPv6 *** Changing the value of sipIpVersion requires a restart for the change to take effect.
AS Server Configuration
Changes to be done on AS server to support IPV6
AS_CLI/System/Device/NetworkServers/Routing> add fd00:10:6b50:4b00::36 unspecified poll false description ns01 ...Done AS_CLI/System/Device/NetworkServers/Routing> get Net Address Port Transport Poll OpState Description ===================================================================== 10.54.181.54 5060 Unspecified false enabled ns01 10.54.181.55 5060 Unspecified false enabled ns02 fd00:10:6b50:4b00::36 Unspecified false enabled ns01 3 entries found.
AS_CLI/System/Device/NetworkServers/Routing> set fd00:10:6b50:4b00::36 port 5060 ...Done AS_CLI/System/Device/NetworkServers/Routing> get Net Address Port Transport Poll OpState Description ===================================================================== 10.54.181.54 5060 Unspecified false enabled ns01 10.54.181.55 5060 Unspecified false enabled ns02 fd00:10:6b50:4b00::36 5060 Unspecified false enabled ns01 3 entries found. AS_CLI/System/Device/NetworkServers/Routing> delete 10.54.181.55 ...Done AS_CLI/System/Device/NetworkServers/Routing> get Net Address Port Transport Poll OpState Description ===================================================================== 10.54.181.54 5060 Unspecified false enabled ns01 fd00:10:6b50:4b00::36 5060 Unspecified false enabled ns01 2 entries found.
AS_CLI/System/Device/NetworkServers/Routing> delete 10.54.181.54 ...Done AS_CLI/System/Device/NetworkServers/Routing> get Net Address Port Transport Poll OpState Description ===================================================================== fd00:10:6b50:4b00::36 5060 Unspecified false enabled ns01 1 entry found.
AS_CLI/System/Device/NetworkServers/Routing> cd /Interface/SIP/ AS_CLI/Interface/SIP> get t1 = 500 t2 = 4000 maxForwardingHops = 10 inviteAuthenticationRatio = 1.0 encryptFromHeader = false 100rel = true useDomainForSubscriberAddress = true accessControl = false sendE164 = false suspiciousAddressThreshold = 3 privacyVersion = RFC3323 privacyEnforceScreening = false listeningPort = 5060 networkProxyHost = networkProxyPort = networkProxyTransport = unspecified accessProxyHost = accessProxyPort = accessProxyTransport = unspecified supportDnsSrv = true maxAddressesPerHostname = 10 maxAddressesPerHostnameInDialog = 4 useDomainForRealm = true defaultRealm = BroadWorks includeT38CapabilityInfo = false reInviteAuthentication = true supportAnswerAfter = true networkSupportGtd = true privateDialPlanOriginatorUsesExtension = false disallowHoldingEmergencyCall = false enableHoldNormalization = true callingPartyCategoryFormat = cpc-gtd networkSupportInviteWithoutSdp = false symmetricSignaling = true supportTcp = true supportDnsNaptr = false sendCarrierSelection = false sendDialedCAC = true originatingTrunkGroupFormat = otg destinationTrunkGroupFormat = dtg supportRFC3398 = false restrictedDisplayName = Anonymous maxNumberTcpSocketsPerSystem = 1000 maxNumberTcpSocketsPerPeer = 100 autoDiscardStaleConnections = false staleConnectionTimerInMinutes = 60 treatDTMFPoundAsFlash = true supportPEarlyMediaHeader = false sendDiversionInhibitor = false networkSupportVideo = true callingPartyE164Normalization = calledCountryCode supportRFC3966PhoneContext = true includePrivacyUser = true broadworksHoldingSDPMethod = holdSDP broadworksHoldingSDPNetAddress = broadworksHoldingSDPIPv6NetAddress = useStrictRFC3264Compliance = false disableSDPChangesForAnswerResponses = false accessForkingSupport = multipleDialogs accessSingleDialogBehavior = singleDialogWithUPDATEIfAllowed accessMultipleDialogBehavior = multipleDialogsWithErrorCorrection networkForkingSupport = multipleDialogs networkSingleDialogBehavior = singleDialogWithUPDATEIfAllowed networkMultipleDialogBehavior = multipleDialogsWithErrorCorrection proxyInfoInAllowHeader = false proxyUpdateInAllowHeader = true useSessionCompletionTimer = true sessionCompletionTimer = 5000 useHistoryInfoHeaderOnNetworkSide = false requiresBroadWorksDigitCollection = false supportXFeatureControl = false chargeHeaderFormat = chargeHeaderTel noaValue = clgp-ani-natl-num forceAnswerSDPOnAnswer = true sendXBroadWorksDNCHeader = true encryptXBroadWorksDNCHeader = false xBroadWorksDNCHeaderKey = m!rUqR\x24T8Z7NgSyD allowBroadWorksConferenceInfo = false sendCallerNameInfoForNetworkCalls = true includeClassmark = false send181Response = true routeToTrunkingDomainByDefault = false clusterAddress = disabledCLIDNumberValue = suppressImplicitReferSubscription = perRFC3515 networkSendIdentityInUpdateAndReInvite = false networkReceiveIdentityInUpdateAndReInvite = false enableTS29163Compliance = true redirectingAssertedIdentityPolicy = assertedIdentity useAssertedIdentityForPrivateCLID = false transferNetworkCauseID = false sipIpVersion = both networkHoldNormalization = useRfc3264 supportPrivacyNone = false reportAltcSupported = false
AS_CLI/Interface/SIP> set sipIpVersion ipv6 SIP IP version change will not take effect until a restart is performed
Media Server Configuration
Changes to be done on Media server to support IPV6
NS_CLI/System/Device/HostingNE/Address> add bwas1 0 10.54.181.51 DualRouting 1 99 MS_CLI/Applications/MediaStreaming/GeneralSettings> get MS_CLI/System/GeneralSettings> get New MS tech-support On AS: AS_CLI/System/GeneralSettings> get AS_CLI/System/StartupParam>get New AS tech-support MS_CLI/Applications/MediaStreaming/GeneralSettings> set mxRecordLookup true *** Warning: BroadWorks needs to be restarted for the changes to take effect *** MS_CLI/Applications/MediaStreaming/GeneralSettings
Supplementary Services & Features Coverage
The following checklist depicts the set of services/features covered through the configuration defined in this Interop Guide.
| Sr.No. | Supplementary Features/Services | Coverage |
|---|---|---|
| 1 | Basic Registration over UDP |
|
| 2 | Basic Call Setup(Audio and Video |
|
| 3 | Basic Call Termination |
|
| 4 | Auto Receptionist (Auto Attendant) |
|
| 5 | Call Waiting |
|
| 6 | Call Hold/Resume |
|
| 7 | Call Transfer - Blind (Cold Transfer) |
|
| 8 | Call Transfer - Consult (Warm Transfer) |
|
| 10 | Local Conference |
|
| 11 | Shared Line Group (SLG) |
|
| 12 | Shared Line Appearance (SLA) or Call Delegation |
|
| 13 | Call Recording |
|
| 14 | Network Conference |
|
| 15 | Session Audit |
|
| 16 | Session timer |
|
| 17 | Ringback |
|
| 18 | Early UPDATE |
|
| 19 | Early-Session |
|
| 20 | DTMF |
|
| 21 | Message Waiting Indicator(MWI) |
|
| 22 | Voice Portal |
|
| 23 | Call Forward |
|
| 24 | GIN and PILOT Registration |
|
| 25 | Surrogate Registration |
|
| 26 | FAX passthrough |
|
| 27 | T38 FAX |
|
| 28 | Busy Lamp Field(BLF) |
|
| 29 | Feature Key Synchronization |
|
| 30 | Security Classification |
|
| 31 | IPV6 Basic and Advanced services |
|
| 32 | Diversion and History-Info |
|
| 33 | Deny Calls from Unregistered Users |
|
| 34 | Enterprise Trunking |
|
| 35 | Click To Dial |
|
| 36 | Click to Answer |
|
| 37 | Click to Hold/Resume |
|
| 38 | Advanced Alerting |
|
| 39 | Do Not Disturb(DND) |
|
Legend
| Supported |
| Not Supported |
| N/A | Not Applicable |
Caveats
Note the following items in relation to this Interop:
- Video collaborate cases are not executed since it requires UVS server which is not available in test lab.
- Web RTC cases are not executed as part of Certification since it requires WebRTC server and WebRTC clients which is not available in test lab.
Support
For any support related queries about this guide, please contact your local Ribbon representative, or use the details below:
- Sales and Support: 1-833-742-2661
- Other Queries: 1-877-412-8867
- Website: https://ribboncommunications.com/about-us
References
For detailed information about Ribbon products & solutions, please visit:
https://ribboncommunications.com/products
https://www.cisco.com/c/en/us/products/unified-communications/broadworks/index.html
Conclusion
This Interoperability Guide describes a successful configuration covering Cisco Broadworks interop involving the SBC Core. All the necessary features and serviceability aspects stand covered as per the details provided in this interoperability document.
All features and capabilities tested are detailed within this document - any limitations, notes or observations are also recorded in order to provide the reader with an accurate understanding of what has been covered and what has not.
Configuration guidance is provided to enable the reader to replicate the same base setup - additional configuration changes are possibly required to suit the exact deployment environment.
© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved.
Overview
Content Tools